TmText
Section: C Library Functions (3)
Updated: 24 July 1993
Index
Return to Main Contents
NAME
TmText
- the Text widget class
SYNOPSIS
xmText
pathName [options]
DESCRIPTION
This is the
tcl
binding to the Motif Text widget.
CLASSES
The class name for resource files is
XmText.
Resources are inherited from
TmPrimitive, TmCore.
Methods are inherited from
TmCore.
RESOURCES
The new resources are
-
autoShowCursorPosition
cursorPosition
editable
editMode
br
marginHeight
marginWidth
maxLength
source
topCharacter
value
valueWCS
verifyBell
- editable
-
The values for this resource are
-
true
false
editMode
The values for this resource are
-
single_line_edit
multi_line_edit
METHODS
New methods for this class are
-
activateCallback
focusCallback
gainPrimaryCallback
losePrimaryCallback
losingFocusCallback
modifyVerifyCallback
motionVerifyCallback
valueChangedCallback
clearSelection
copy
cut
disableRedisplay
enableRedisplay
findString
getEditable
getInsertionPosition
getSelection
getSelectionPosition
getString
getSubstring
getTopCharacter
insert
paste
replace
remove
scroll
setAddMode
setEditable
setHighlight
setInsertionPosition
setSelection
setSource
setString
setTopCharacter
showPosition
- clearSelection
-
clears the primary selection
- copy
-
copies the primary selection to the clipboard
- cut
-
copies the primary selection to the clipboard and deletes the selected text.
- findString start string direction position
-
searches for the
string
in the specified
direction
starting from the given
start.
The possible values of
direction
are forward or backward.
The method returns true or false if the string is found
or not found.
If it is found, the location of the first character of the string
(counting from 0) is returned in the tcl variable
position.
- getEditable
-
returns true or false indicating
whether or not the widget can be edited.
- getInsertionPosition
-
returns the location of the insertion cursor.
- getLastPosition
-
returns the last position in the text.
- getSelection
-
returns the value of the primary selection.
- getSelectionPosition left right
-
returns true f the widget owns the primary selection,
else returns false.
The left and right positions of the primary selection are returned
in the tcl variables
left and right.
- getString
-
returns the value in the widget.
- getSubstring start num_chars buffer
-
stores the substring in the tcl variable
buffer.
The method returns succeded, failed or truncated.
- getTopCharacter
-
returns the position of the first character displayed.
- insert position text
-
inserts the text into the widget at position.
- paste
-
insert the clipboard selection.
- replace from to value
-
replaces the text with the new value.
- scroll lines
-
scroll the text widget. A negative number of lines scrolls downward.
- setAddMode boolean
-
sets the add mode of the text widget.
- setEditable boolean
-
set the editable state of the widget.
- setHighlight left right mode
-
set the highlight mode for the text between the positions to one
of the highlight values of
normal selected secondary_selected.
- setInsertionPosition position
-
set the location of the insertion cursor.
- setSelection first last
-
set the primary selection of the text to between the positions.
- setSource widget top position
-
sets the source of the current text widget to be the same as
widget and specifies where the top display and where the insertion
cursor are.
- setString value
-
sets the text value.
- setTopCharacter top
-
sets the top position of the text display.
- showPosition position
-
force the text at the position to be displayed.
CALLBACK SUBSTITUTIONS
The substitutions supported for this class are
-
%reason
- the additional values are
-
activate
focus
gain_primary
lose_primary
modifying_text_value
moving_insert_cursor
value_changed
%doit
- the tcl variable to set to true or false to allow changes
%currInsert
- current position of the insertion cursor
%newInsert
- position to which cursor move is attempted
%startPos
- itcl variable with starting position of text to modify
%endPos
- tcl variable with end position of text to modify
%ptr
- tcl variable with text to be inserted
%length
- tcl variable with length of text to be inserted
AUTHOR
Jan Newmarch, University of Canberra
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- CLASSES
-
- RESOURCES
-
- METHODS
-
- CALLBACK SUBSTITUTIONS
-
- AUTHOR
-
This document was created by
man2html,
using the manual pages.
Time: 20:43:53 GMT, June 11, 2022